Added comment describing usage.

Signed-off-by: Ewan Mellor <ewan@xensource.com>

diff --git a/tools/python/xen/xend/xenstore/xswatch.py b/tools/python/xen/xend/xenstore/xswatch.py
index 8b8bb2d087a42835ed6c71c72ec3466a0db74541..e84fe83ba9a9cf510d61a4727ac65a6827c20dc7 100644 (file)
--- a/tools/python/xen/xend/xenstore/xswatch.py
+++ b/tools/python/xen/xend/xenstore/xswatch.py
@@ -13,6 +13,18 @@ from xen.xend.XendLogging import log
 
 class xswatch:
 
+    ##
+    # Create a watch on the given path in the store.  The watch will fire
+    # immediately, then subsequently each time the watched path is changed,
+    # until the watch is deregistered, either by the return value from the
+    # watch callback being False, or by an explicit call to unwatch.
+    #
+    # @param fn The function to be called when the watch fires.  This function
+    # should take the path that has changed as its first argument, followed by
+    # the extra arguments given to this constructor, if any.  It should return
+    # True if the watch is to remain registered, or False if it is to be
+    # deregistered.
+    #
     def __init__(self, path, fn, *args, **kwargs):
         self.path = path
         self.fn = fn